

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The page module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The http module" href="mod_pyamp_web_http.html" />
    <link rel="next" title="The constants module" href="pyamp_web_http_constants.html" />
    <link rel="prev" title="The headers module" href="pyamp_web_http_headers.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_constants.html" title="The constants module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_headers.html" title="The headers module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" >The web module</a> &raquo;</li>
          <li><a href="mod_pyamp_web_http.html" accesskey="U">The http module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.web.http.page">
<span id="the-page-module"></span><h1>The page module<a class="headerlink" href="#module-pyamp.web.http.page" title="Permalink to this headline">¶</a></h1>
<p>The page module contains the definition of the BasePage class
which provides the base functionality for implementing a page that
can be served by an HTTP server.</p>
<p>This module also contains other classes for defining various types
of pages.</p>
<div class="section" id="the-jsonpage-class">
<h2>The JsonPage class<a class="headerlink" href="#the-jsonpage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-5058b6943ebf54fa49c3f47bdf3868e4dca9a82f.png" alt="Inheritance diagram of pyamp.web.http.page.JsonPage" usemap="#inheritancee46a87a58f" class="inheritance"/>
<map id="inheritancee46a87a58f" name="inheritancee46a87a58f">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.JsonPage" title="pyamp.web.http.page.JsonPage" alt="" coords="112,161,333,188"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.JsonPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">JsonPage</tt><a class="reference internal" href="../_modules/pyamp/web/http/page.html#JsonPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.page.JsonPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The HtmlPage class provides a base class that returns
a page containing JSON content.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.page.JsonPage.contentType">
<tt class="descname">contentType</tt><a class="headerlink" href="#pyamp.web.http.page.JsonPage.contentType" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the content type for the JsonPage.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.JsonPage.get">
<em class="property">classmethod </em><tt class="descname">get</tt><big>(</big><em>requestHandler</em>, <em>path</em>, <em>arguments</em><big>)</big><a class="reference internal" href="../_modules/pyamp/web/http/page.html#JsonPage.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.page.JsonPage.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Override the get method to return JSON data.</p>
<ul class="simple">
<li>requestHandler &#8211; The request handler object</li>
<li>path &#8211; The requested path</li>
<li>arguments &#8211; The request arguments dictionary</li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-argument-class">
<h2>The Argument class<a class="headerlink" href="#the-argument-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-3592708fed718c7b40f4f8318a30c87cd8d99697.png" alt="Inheritance diagram of pyamp.web.http.page.Argument" usemap="#inheritancecee5b49b4c" class="inheritance"/>
<map id="inheritancecee5b49b4c" name="inheritancecee5b49b4c">
<area shape="rect" href="pyamp_web_http_argument.html#pyamp.web.http.argument.Argument" title="pyamp.web.http.argument.Argument" alt="" coords="5,7,264,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.Argument">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">Argument</tt><big>(</big><em>argumentType</em>, <em>required=False</em>, <em>default=None</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Argument" title="Permalink to this definition">¶</a></dt>
<dd><p>The Argument class encapsulates the concept of an HTTP argument
passed through a URL request.</p>
<p>Arguments can have a specific type, can be required or optional,
and can have a default value if they are optional and not passed in
the request.</p>
<ul class="simple">
<li>argumentType &#8211; The type of the argument</li>
<li>required &#8211; True if the argument is required, False otherwise</li>
<li>default &#8211; The default value for optional Arguments</li>
</ul>
<dl class="method">
<dt id="pyamp.web.http.page.Argument.convertValue">
<tt class="descname">convertValue</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Argument.convertValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the given value to the expected type of the Argument.</p>
<ul class="simple">
<li>value &#8211; The value of the argument passed in the request</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.web.http.page.Argument.getDefaultValue">
<tt class="descname">getDefaultValue</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Argument.getDefaultValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default value for this Argument.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.web.http.page.Argument.isRequired">
<tt class="descname">isRequired</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Argument.isRequired" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if this is a required Argument or an optional Argument.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-header-class">
<h2>The Header class<a class="headerlink" href="#the-header-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-ef01656992e7d98a77406b2ff90de41d91cba1af.png" alt="Inheritance diagram of pyamp.web.http.page.Header" usemap="#inheritance7b6271eb5f" class="inheritance"/>
<map id="inheritance7b6271eb5f" name="inheritance7b6271eb5f">
<area shape="rect" href="../web.html#pyamp.web.http.headers.Header" title="pyamp.web.http.headers.Header" alt="" coords="5,7,237,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.Header">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">Header</tt><big>(</big><em>identifier</em>, <em>value</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header" title="Permalink to this definition">¶</a></dt>
<dd><p>The Header class provides the ability to create a specific
HTTP header.</p>
<ul class="simple">
<li>identifier &#8211; The header identifier</li>
<li>value &#8211; The value for the header</li>
</ul>
<dl class="classmethod">
<dt id="pyamp.web.http.page.Header.contentType">
<em class="property">classmethod </em><tt class="descname">contentType</tt><big>(</big><em>contentType</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.contentType" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a content type header.</p>
<ul class="simple">
<li>contentType &#8211; The type of content</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.web.http.page.Header.getId">
<tt class="descname">getId</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.getId" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ID for this header.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.Header.getOperatingSystem">
<em class="property">classmethod </em><tt class="descname">getOperatingSystem</tt><big>(</big><em>headers</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.getOperatingSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the operating system from the given headers.</p>
<ul class="simple">
<li>headers &#8211; The headers</li>
</ul>
</dd></dl>

<dl class="method">
<dt id="pyamp.web.http.page.Header.getValue">
<tt class="descname">getValue</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the value for this header.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.Header.jsonContent">
<em class="property">classmethod </em><tt class="descname">jsonContent</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.jsonContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a JSON content type header.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.Header.location">
<em class="property">classmethod </em><tt class="descname">location</tt><big>(</big><em>location</em><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.location" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a location header.</p>
<ul class="simple">
<li>location &#8211; The location</li>
</ul>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.Header.textHtmlContent">
<em class="property">classmethod </em><tt class="descname">textHtmlContent</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.Header.textHtmlContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an text/html content type header.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-filepage-class">
<h2>The FilePage class<a class="headerlink" href="#the-filepage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-7a2a2725812d3f1bf9f864b24e32ced13cc93e3d.png" alt="Inheritance diagram of pyamp.web.http.page.FilePage" usemap="#inheritance94d88f519c" class="inheritance"/>
<map id="inheritance94d88f519c" name="inheritance94d88f519c">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.FilePage" title="pyamp.web.http.page.FilePage" alt="" coords="115,161,331,188"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.FilePage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">FilePage</tt><a class="headerlink" href="#pyamp.web.http.page.FilePage" title="Permalink to this definition">¶</a></dt>
<dd><p>The FilePage class implements a <a class="reference internal" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage"><tt class="xref py py-class docutils literal"><span class="pre">BasePage</span></tt></a> object which provides
the ability for pages to return the content of a file.</p>
<p>Check that all the required properties are defined.</p>
</dd></dl>

</div>
<div class="section" id="the-directoryfilespage-class">
<h2>The DirectoryFilesPage class<a class="headerlink" href="#the-directoryfilespage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-afea32fb420f8374d1de60672a6f310e16139cb5.png" alt="Inheritance diagram of pyamp.web.http.page.DirectoryFilesPage" usemap="#inheritance5eb22a30f2" class="inheritance"/>
<map id="inheritance5eb22a30f2" name="inheritance5eb22a30f2">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.FilePage" title="pyamp.web.http.page.FilePage" alt="" coords="115,161,331,188"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.DirectoryFilesPage" title="pyamp.web.http.page.DirectoryFilesPage" alt="" coords="83,239,363,265"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.DirectoryFilesPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">DirectoryFilesPage</tt><a class="headerlink" href="#pyamp.web.http.page.DirectoryFilesPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The DirectoryFilesPage class provides an implementation of a FilePage
which provides the ability to return any file contained within a specific
directory.</p>
<p>This class allows the path to the locally stored files to be defined, as
well as the HTML directory where the files are located. This class also
provides the ability to define a set of extensions used to filter the
files returned. Any file that has an extension that is contained within
the list of supported extensions will be requested using this Page.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.page.DirectoryFilesPage.directoryPath">
<tt class="descname">directoryPath</tt><a class="headerlink" href="#pyamp.web.http.page.DirectoryFilesPage.directoryPath" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to the locally stored files that this Page will return.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.page.DirectoryFilesPage.extensions">
<tt class="descname">extensions</tt><a class="headerlink" href="#pyamp.web.http.page.DirectoryFilesPage.extensions" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of extensions used to filter files that are returned.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.DirectoryFilesPage.getUrls">
<em class="property">classmethod </em><tt class="descname">getUrls</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.DirectoryFilesPage.getUrls" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of URLs which this Page supports. These URLs are used
in conjunction with the <tt class="xref py py-attr docutils literal"><span class="pre">urls</span></tt> class property.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.page.DirectoryFilesPage.htmlDirectory">
<tt class="descname">htmlDirectory</tt><a class="headerlink" href="#pyamp.web.http.page.DirectoryFilesPage.htmlDirectory" title="Permalink to this definition">¶</a></dt>
<dd><p>The HTML directory name where the files are stored. This is also the
path that will be prefixed to all requests for these pages.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-basepage-class">
<h2>The BasePage class<a class="headerlink" href="#the-basepage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-c6d4e756fc1153db5012c205ca64cabcb679651f.png" alt="Inheritance diagram of pyamp.web.http.page.BasePage" usemap="#inheritance09491102fb" class="inheritance"/>
<map id="inheritance09491102fb" name="inheritance09491102fb">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.BasePage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">BasePage</tt><a class="reference internal" href="../_modules/pyamp/web/http/page.html#BasePage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.page.BasePage" title="Permalink to this definition">¶</a></dt>
<dd><p>The BasePage class contains the basic functionality that is shared
among all pages.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.page.BasePage.arguments">
<tt class="descname">arguments</tt><a class="headerlink" href="#pyamp.web.http.page.BasePage.arguments" title="Permalink to this definition">¶</a></dt>
<dd><p>The arguments class defines a dictionary mapping names of arguments
to actual Argument objects that this Page accepts. These can be required,
or optional arguments. This provides the ability to perform error
checking on the request to the page to determine if the correct number of
arguments was passed in the request.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.page.BasePage.contentType">
<tt class="descname">contentType</tt><a class="headerlink" href="#pyamp.web.http.page.BasePage.contentType" title="Permalink to this definition">¶</a></dt>
<dd><p>The contentType property contains the type of content contained
in this Page.</p>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.page.BasePage.errorCodes">
<tt class="descname">errorCodes</tt><a class="headerlink" href="#pyamp.web.http.page.BasePage.errorCodes" title="Permalink to this definition">¶</a></dt>
<dd><p>The errorCodes property defines the list of error codes that will
respond with this Page in the event that any of the error codes are
encountered.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.BasePage.get">
<em class="property">classmethod </em><tt class="descname">get</tt><big>(</big><em>requestHandler</em>, <em>path</em>, <em>arguments</em><big>)</big><a class="reference internal" href="../_modules/pyamp/web/http/page.html#BasePage.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.page.BasePage.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the page.</p>
<ul class="simple">
<li>requestHandler &#8211; The request handler object</li>
<li>path &#8211; The requested path</li>
<li>arguments &#8211; The request arguments dictionary</li>
</ul>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.BasePage.getUrls">
<em class="property">classmethod </em><tt class="descname">getUrls</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.BasePage.getUrls" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of URLs which this Page supports. These URLs are used
in conjunction with the <a class="reference internal" href="../web.html#pyamp.web.http.page.BasePage.urls" title="pyamp.web.http.page.BasePage.urls"><tt class="xref py py-attr docutils literal"><span class="pre">urls</span></tt></a> class property.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This function should be overridden by concrete Pages to
provide a set of dynamically configured URLs.</p>
</div>
</dd></dl>

<dl class="attribute">
<dt id="pyamp.web.http.page.BasePage.urls">
<tt class="descname">urls</tt><a class="headerlink" href="#pyamp.web.http.page.BasePage.urls" title="Permalink to this definition">¶</a></dt>
<dd><p>The urls property defines the list of URLs that can be used to request
this Page.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These URLs should all start with a forward slash.</p>
</div>
<p>Example:</p>
<div class="highlight-python"><pre>urls = ['/index.html', /test/directory/main.html']</pre>
</div>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.http.page.BasePage.validatePage">
<em class="property">classmethod </em><tt class="descname">validatePage</tt><big>(</big><big>)</big><a class="headerlink" href="#pyamp.web.http.page.BasePage.validatePage" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate all of the properties for this page.</p>
<p>Return True to indicate success, False to indicate failure</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-htmlpage-class">
<h2>The HtmlPage class<a class="headerlink" href="#the-htmlpage-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-634e7731a94d53a0d01108582e9c53cfaa84f142.png" alt="Inheritance diagram of pyamp.web.http.page.HtmlPage" usemap="#inheritance9a8572b52b" class="inheritance"/>
<map id="inheritance9a8572b52b" name="inheritance9a8572b52b">
<area shape="rect" href="pyamp_patterns_interfaces_requiredProperties.html#pyamp.patterns.interfaces.requiredProperties.RequiredProperties" title="pyamp.patterns.interfaces.requiredProperties.RequiredProperties" alt="" coords="5,7,440,33"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.BasePage" title="pyamp.web.http.page.BasePage" alt="" coords="109,84,336,111"/>
<area shape="rect" href="../web.html#pyamp.web.http.page.HtmlPage" title="pyamp.web.http.page.HtmlPage" alt="" coords="109,161,336,188"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.http.page.HtmlPage">
<em class="property">class </em><tt class="descclassname">pyamp.web.http.page.</tt><tt class="descname">HtmlPage</tt><a class="reference internal" href="../_modules/pyamp/web/http/page.html#HtmlPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.http.page.HtmlPage" title="Permalink to this definition">¶</a></dt>
<dd><p>The HtmlPage class provides a base class that returns
a page containing text/html content.</p>
<p>Check that all the required properties are defined.</p>
<dl class="attribute">
<dt id="pyamp.web.http.page.HtmlPage.contentType">
<tt class="descname">contentType</tt><a class="headerlink" href="#pyamp.web.http.page.HtmlPage.contentType" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the content type for the HtmlPage.</p>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The page module</a><ul>
<li><a class="reference internal" href="#the-jsonpage-class">The JsonPage class</a></li>
<li><a class="reference internal" href="#the-argument-class">The Argument class</a></li>
<li><a class="reference internal" href="#the-header-class">The Header class</a></li>
<li><a class="reference internal" href="#the-filepage-class">The FilePage class</a></li>
<li><a class="reference internal" href="#the-directoryfilespage-class">The DirectoryFilesPage class</a></li>
<li><a class="reference internal" href="#the-basepage-class">The BasePage class</a></li>
<li><a class="reference internal" href="#the-htmlpage-class">The HtmlPage class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_web_http_headers.html"
                        title="previous chapter">The headers module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pyamp_web_http_constants.html"
                        title="next chapter">The constants module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_web_http_page.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_constants.html" title="The constants module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_web_http_headers.html" title="The headers module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" >The web module</a> &raquo;</li>
          <li><a href="mod_pyamp_web_http.html" >The http module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>